Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

launchtemplate docs #773

Merged
merged 14 commits into from
Nov 17, 2021
Merged

launchtemplate docs #773

merged 14 commits into from
Nov 17, 2021

Conversation

geoffcline
Copy link
Contributor

1. Issue, if available:
https://github.com/awslabs/karpenter/projects/4#card-65981773

2. Description of changes:
Add a new page describing launch templates, including requirements and sample procedure.

3. Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@netlify
Copy link

netlify bot commented Oct 26, 2021

✔️ Deploy Preview for karpenter-docs-prod ready!

🔨 Explore the source changes: ff0a33d

🔍 Inspect the deploy log: https://app.netlify.com/sites/karpenter-docs-prod/deploys/61955e7d116729000830bd4a

😎 Browse the preview: https://deploy-preview-773--karpenter-docs-prod.netlify.app

@geoffcline
Copy link
Contributor Author

@geoffcline geoffcline added the documentation Improvements or additions to documentation label Oct 26, 2021
@geoffcline geoffcline linked an issue Oct 26, 2021 that may be closed by this pull request
@geoffcline geoffcline self-assigned this Oct 26, 2021
website/content/en/docs/launch-templates.md Outdated Show resolved Hide resolved
website/content/en/docs/launch-templates.md Outdated Show resolved Hide resolved
website/content/en/docs/launch-templates.md Outdated Show resolved Hide resolved
website/content/en/docs/launch-templates.md Outdated Show resolved Hide resolved
website/content/en/docs/launch-templates.md Outdated Show resolved Hide resolved
website/content/en/docs/launch-templates.md Outdated Show resolved Hide resolved
@geoffcline
Copy link
Contributor Author

thanks for the thoughtful feedback @JacobGabrielson :)

-Geoffrey

@geoffcline geoffcline changed the title draft launchtemplate docs [wip] draft launchtemplate docs Nov 1, 2021
@@ -0,0 +1,207 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to put this section under a parent AWS Provider section.

@geoffcline geoffcline changed the title [wip] draft launchtemplate docs draft launchtemplate docs Nov 4, 2021
@geoffcline
Copy link
Contributor Author

new draft pushed and ready for review 🥳

@@ -1,13 +1,11 @@
---
title: "Amazon Web Services (AWS)"
linkTitle: "AWS"
title: "Specifying Values to Control AWS Provisioning"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd keep this simple and directly related to our concept of what this page is like "AWS Cloud Provider".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this page lives in the "AWS" navigation section / folder, I'd like to give it a more descriptive title, than just repeating AWS.

docs/AWS/AWS.html vs

docs/AWS/labels.html or constraints.html etc

Copy link
Contributor

@eptiger eptiger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like seeing this doc come together! I have a lot of nits that you can use or ignore, up to you.


### Instance Profile - IAM

The launch template must include an "instance profile" -- a set of IAM roles.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you say an IAM role

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry this got dropped?

bwagner5
bwagner5 previously approved these changes Nov 15, 2021
Copy link
Contributor

@bwagner5 bwagner5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm!

bwagner5
bwagner5 previously approved these changes Nov 15, 2021
Copy link
Contributor

@bwagner5 bwagner5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

ellistarn
ellistarn previously approved these changes Nov 17, 2021
@geoffcline geoffcline changed the title draft launchtemplate docs launchtemplate docs Nov 17, 2021
@bwagner5 bwagner5 merged commit 1f7c5c3 into aws:main Nov 17, 2021
@geoffcline geoffcline deleted the launch-template branch November 17, 2021 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document requirements for launch templates
5 participants